<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../print.css" type="text/css" media="print">
<meta content="IViewCursor,mx.collections.IViewCursor,afterLast,beforeFirst,bookmark,current,view,findAny,findFirst,findLast,insert,moveNext,movePrevious,remove,seek" name="keywords">
<title>mx.collections.IViewCursor</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'IViewCursor - Zentrum virtUOS: virtPresenter';
				var baseRef = '../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">virtPresenter AsDoc</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../all-classes.html')" href="../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../all-classes.html')" href="../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../index-list.html')" href="../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../index.html?mx/collections/IViewCursor.html&amp;mx/collections/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Interface&nbsp;IViewCursor</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a>&nbsp;| <a href="#eventSummary">Events</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Interface IViewCursor"); titleBar_setSubNav(false,true,false,false,true,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">mx.collections</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Interface</td><td class="classSignature">public interface IViewCursor extends <a href="none">flash.events.IEventDispatcher</a></td>
</tr>
</table>
<p></p>
  Defines the interface for enumerating a collection view bi-directionally.
  This cursor provides find, seek, and bookmarking capabilities along
  with the modification methods insert and remove.  
  When a cursor is first retrieved from a view, (typically by the ICollectionView
  <code>createCursor()</code> method) the value of the 
  <code>current</code> property should be the first
  item in the view, unless the view is empty.
 <p></p>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#afterLast">afterLast</a> : Boolean<div class="summaryTableDescription">[read-only]
      If the cursor is located after the last item in the view, 
      this property is <code>true</code> .</div>
</td><td class="summaryTableOwnerCol">IViewCursor</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#beforeFirst">beforeFirst</a> : Boolean<div class="summaryTableDescription">[read-only]
      If the cursor is located before the first item in the view,
      this property is <code>true</code>.</div>
</td><td class="summaryTableOwnerCol">IViewCursor</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#bookmark">bookmark</a> : <a href="../collections/CursorBookmark.html">CursorBookmark</a>
<div class="summaryTableDescription">[read-only]
      Provides access to a bookmark that corresponds to the item
      returned by the <code>current</code> property.</div>
</td><td class="summaryTableOwnerCol">IViewCursor</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#current">current</a> : Object<div class="summaryTableDescription">[read-only]
      Provides access the object at the location
      in the source collection referenced by this cursor.</div>
</td><td class="summaryTableOwnerCol">IViewCursor</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#view">view</a> : <a href="../collections/ICollectionView.html">ICollectionView</a>
<div class="summaryTableDescription">[read-only]
      A reference to the ICollectionView with which this cursor is associated.</div>
</td><td class="summaryTableOwnerCol">IViewCursor</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#findAny()">findAny</a>(values:Object):Boolean</div>
<div class="summaryTableDescription">
      Finds an item with the specified properties within the collection
      and positions the cursor to that item.</div>
</td><td class="summaryTableOwnerCol">IViewCursor</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#findFirst()">findFirst</a>(values:Object):Boolean</div>
<div class="summaryTableDescription">
      Finds the first item with the specified properties within the collection
      and positions the cursor to that item.</div>
</td><td class="summaryTableOwnerCol">IViewCursor</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#findLast()">findLast</a>(values:Object):Boolean</div>
<div class="summaryTableDescription">
      Finds the last item with the specified properties within the collection
      and positions the cursor on that item.</div>
</td><td class="summaryTableOwnerCol">IViewCursor</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#insert()">insert</a>(item:Object):void</div>
<div class="summaryTableDescription">
      Inserts the specified item before the cursor's current position.</div>
</td><td class="summaryTableOwnerCol">IViewCursor</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#moveNext()">moveNext</a>():Boolean</div>
<div class="summaryTableDescription">
      Moves the cursor to the next item within the collection.</div>
</td><td class="summaryTableOwnerCol">IViewCursor</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#movePrevious()">movePrevious</a>():Boolean</div>
<div class="summaryTableDescription">
      Moves the cursor to the previous item within the collection.</div>
</td><td class="summaryTableOwnerCol">IViewCursor</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#remove()">remove</a>():Object</div>
<div class="summaryTableDescription">
      Removes the current item and returns it.</div>
</td><td class="summaryTableOwnerCol">IViewCursor</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#seek()">seek</a>(bookmark:<a href="CursorBookmark.html">CursorBookmark</a>, offset:int = 0, prefetch:int = 0):void</div>
<div class="summaryTableDescription">
      Moves the cursor to a location at an offset from the specified
      bookmark.</div>
</td><td class="summaryTableOwnerCol">IViewCursor</td>
</tr>
</table>
</div>
<a name="eventSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Events</div>
<table id="summaryTableEvent" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Event</th><th>Summary</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:cursorUpdate">cursorUpdate</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
  Dispatched whenever the cursor position is updated.</td><td class="summaryTableOwnerCol">IViewCursor</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="afterLast"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">afterLast</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>afterLast:Boolean</code>&nbsp;&nbsp;[read-only]<p>
      If the cursor is located after the last item in the view, 
      this property is <code>true</code> .
      If the ICollectionView is empty (length == 0),
      this property is <code>true</code>.
     </p><p>This property can be used as the source for data binding.</p>
<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get afterLast():Boolean</code>
<br>
</div>
<a name="beforeFirst"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">beforeFirst</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>beforeFirst:Boolean</code>&nbsp;&nbsp;[read-only]<p>
      If the cursor is located before the first item in the view,
      this property is <code>true</code>.
      If the ICollectionView is empty (length == 0),
      this property is <code>true</code>.
     </p><p>This property can be used as the source for data binding.</p>
<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get beforeFirst():Boolean</code>
<br>
</div>
<a name="bookmark"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">bookmark</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>bookmark:<a href="../collections/CursorBookmark.html">CursorBookmark</a></code>&nbsp;&nbsp;[read-only]<p>
      Provides access to a bookmark that corresponds to the item
      returned by the <code>current</code> property.
      The bookmark can be used to move the cursor
      to a previously visited item, or to a position relative to that item.
      (See the <code>seek()</code> method for more information.)
           </p><p>This property can be used as the source for data binding.</p>
<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get bookmark():<a href="../collections/CursorBookmark.html">CursorBookmark</a></code>
<br>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../collections/IViewCursor.html#current" target="">current</a>
<br>
<a href="../collections/IViewCursor.html#seek()" target="">seek()</a>
</div>
</div>
<a name="current"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">current</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>current:Object</code>&nbsp;&nbsp;[read-only]<p>
      Provides access the object at the location
      in the source collection referenced by this cursor.
      If the cursor is beyond the ends of the collection
      (<code>beforeFirst</code>, <code>afterLast</code>)
      this will return <code>null</code>.
           </p><p>This property can be used as the source for data binding.</p>
<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get current():Object</code>
<br>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../collections/IViewCursor.html#moveNext()" target="">moveNext()</a>
<br>
<a href="../collections/IViewCursor.html#movePrevious()" target="">movePrevious()</a>
<br>
<a href="../collections/IViewCursor.html#seek()" target="">seek()</a>
<br>
<a href="../collections/IViewCursor.html#beforeFirst" target="">beforeFirst</a>
<br>
<a href="../collections/IViewCursor.html#afterLast" target="">afterLast</a>
</div>
</div>
<a name="view"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">view</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>view:<a href="../collections/ICollectionView.html">ICollectionView</a></code>&nbsp;&nbsp;[read-only]<p>
      A reference to the ICollectionView with which this cursor is associated.
     </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get view():<a href="../collections/ICollectionView.html">ICollectionView</a></code>
<br>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="findAny()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">findAny</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function findAny(values:Object):Boolean</code><p>
      Finds an item with the specified properties within the collection
      and positions the cursor to that item.
      If the item can not be found, the cursor location does not change.
           </p><p>The <code>findAny()</code> method can only be called on sorted views;
      if the view isn't sorted, a <code>CursorError</code> is thrown.</p>
      
      <p>If the associated collection is remote, and not all of the items
      have been cached locally, this method begins an asynchronous fetch
      from the remote collection. If one is already in progress, this method
      waits for it to complete before making another fetch request.</p>
           <p>If multiple items can match the search criteria then the item found
      is non-deterministic.
      If it is important to find the first or last occurrence of an item
      in a non-unique index, use the <code>findFirst()</code> or
      <code>findLast()</code> method.</p>
           <p>The values in the parameter must be configured as name-value pairs,
      as in an associative array (or be the actual object to search for).
      The values of the names specified must match properties
      specified in the sort.
      For example, if properties <code>x</code>, <code>y</code>, and
      <code>z</code> are in the current sort, the values specified should be
      <code>{x: <i>x-value</i>, y: <i>y-value</i>, z: <i>z-value</i>}</code>.</p>
           <p>When all of the data is local this method returns
      <code>true</code> if the item can be found and <code>false</code>
      otherwise.
      If the data is not local and an asynchronous operation must be
      performed, an ItemPendingError is thrown.</p>
           <span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">values</span>:Object</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code></td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../collections/IViewCursor.html#findFirst()" target="">findFirst()</a>
<br>
<a href="../collections/IViewCursor.html#findLast()" target="">findLast()</a>
<br>
<a href="errors/ItemPendingError.html" target="">mx.collections.errors.ItemPendingError</a>
</div>
</div>
<a name="findFirst()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">findFirst</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function findFirst(values:Object):Boolean</code><p>
      Finds the first item with the specified properties within the collection
      and positions the cursor to that item.
      If the item can not be found, no cursor location does not change.
           </p><p>The <code>findFirst()</code> method can only be called on sorted views;
      if the view isn't sorted, a <code>CursorError</code> is thrown.</p>
      
      <p>If the associated collection is remote, and not all of the items
      have been cached locally, this method begins an asynchronous fetch
      from the remote collection. If one is already in progress, this method
      waits for it to complete before making another fetch request.</p>
           <p>If it is not important to find the first occurrence of an item
      in a non-unique index, use <code>findAny()</code>, which may be
      a little faster than the <code>findFirst() method</code>.</p>
           <p>The values specified must be configured as name-value pairs,
      as in an associative array (or be the actual object to search for).
      The values of the names specified must match properties
      specified in the sort.
      For example, if properties <code>x</code>, <code>y</code>, and
      <code>z</code> are in the current sort, the values specified should be
      <code>{x: <i>x-value</i>, y: <i>y-value</i>, z: <i>z-value</i>}</code>.</p>
           <p>When all of the data is local this method returns
      <code>true</code> if the item can be found and <code>false</code>
      otherwise.
      If the data is not local and an asynchronous operation must be
      performed, an ItemPendingError is thrown.</p>
           <span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">values</span>:Object</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code></td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../collections/IViewCursor.html#findAny()" target="">findAny()</a>
<br>
<a href="../collections/IViewCursor.html#findLast()" target="">findLast()</a>
<br>
<a href="errors/ItemPendingError.html" target="">mx.collections.errors.ItemPendingError</a>
</div>
</div>
<a name="findLast()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">findLast</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function findLast(values:Object):Boolean</code><p>
      Finds the last item with the specified properties within the collection
      and positions the cursor on that item.
      If the item can not be found, the cursor location does not chanage.
           </p><p>The <code>findLast()</code> method can only be called on sorted views;
      if the view isn't sorted, a <code>CursorError</code> is thrown.</p>
      
      <p>If the associated collection is remote, and not all of the items
      have been cached locally, this method begins an asynchronous fetch
      from the remote collection. If one is already in progress, this method
      waits for it to complete before making another fetch request.</p>
           <p>If it is not important to find the last occurrence of an item
      in a non-unique index, use the <code>findAny()</code> method, which
      may be a little faster.</p>
           <p>The values specified must be configured as name-value pairs,
      as in an associative array (or be the actual object to search for).
      The values of the names specified must match properties
      specified in the sort.
      For example, if properties <code>x</code>, <code>y</code>, and
      <code>z</code> are in the current sort, the values specified should be
      <code>{x: <i>x-value</i>, y: <i>y-value</i>, z: <i>z-value</i>}</code>.</p>
           <p>When all of the data is local this method returns
      <code>true</code> if the item can be found and <code>false</code>
      otherwise.
      If the data is not local and an asynchronous operation must be
      performed, an ItemPendingError is thrown.</p>
           <span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">values</span>:Object</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code></td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../collections/IViewCursor.html#findAny()" target="">findAny()</a>
<br>
<a href="../collections/IViewCursor.html#findFirst()" target="">findFirst()</a>
<br>
<a href="errors/ItemPendingError.html" target="">mx.collections.errors.ItemPendingError</a>
</div>
</div>
<a name="insert()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">insert</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function insert(item:Object):void</code><p>
      Inserts the specified item before the cursor's current position.
      If the cursor is <code>afterLast</code>,
      the insertion occurs at the end of the view.
      If the cursor is <code>beforeFirst</code> on a non-empty view,
      an error is thrown.
     </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">item</span>:Object</code></td>
</tr>
</table>
</div>
<a name="moveNext()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">moveNext</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function moveNext():Boolean</code><p>
      Moves the cursor to the next item within the collection.
      On success the <code>current</code> property is updated
      to reference the object at this new location.
      Returns <code>true</code> if the resulting <code>current</code> 
      property is valid, or <code>false</code> if not 
      (the property value is <code>afterLast</code>).
           </p><p>If the data is not local and an asynchronous operation must be performed,
      an ItemPendingError is thrown.
      See the ItemPendingError documentation and  the collections
      documentation for more information on using the ItemPendingError.</p>
           <p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code> &mdash; <code>true</code> if still in the list,
      <code>false</code> if the <code>current</code> value initially was
      or now is <code>afterLast</code>.
           </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../collections/IViewCursor.html#current" target="">current</a>
<br>
<a href="../collections/IViewCursor.html#movePrevious()" target="">movePrevious()</a>
<br>
<a href="errors/ItemPendingError.html" target="">mx.collections.errors.ItemPendingError</a>
</div>
<br>
<span class="label">Example</span>
<br>      <pre>
      var myArrayCollection:ICollectionView = new ArrayCollection([ "Bobby", "Mark", "Trevor", "Jacey", "Tyler" ]);
      var cursor:IViewCursor = myArrayCollection.createCursor();
      while (!cursor.afterLast)
      {
          trace(cursor.current);
          cursor.moveNext();
      }
      </pre>
     <p></p>
</div>
<a name="movePrevious()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">movePrevious</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function movePrevious():Boolean</code><p>
      Moves the cursor to the previous item within the collection.
      On success the <code>current</code> property is updated
      to reference the object at this new location.
      Returns <code>true</code> if the resulting <code>current</code> 
      property is valid, or <code>false</code> if not 
      (the property value is <code>beforeFirst</code>).
           </p><p>If the data is not local and an asynchronous operation must be performed,
      an ItemPendingError is thrown.
      See the ItemPendingError documentation and the collections
      documentation for more information on using the ItemPendingError.</p>
           <p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code> &mdash; <code>true</code> if still in the list,
      <code>false</code> if the <code>current</code> value initially was or
      now is <code>beforeFirst</code>.
           </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../collections/IViewCursor.html#current" target="">current</a>
<br>
<a href="../collections/IViewCursor.html#moveNext()" target="">moveNext()</a>
<br>
<a href="errors/ItemPendingError.html" target="">mx.collections.errors.ItemPendingError</a>
</div>
<br>
<span class="label">Example</span>
<br>      <pre>
      var myArrayCollection:ICollectionView = new ArrayCollection([ "Bobby", "Mark", "Trevor", "Jacey", "Tyler" ]);
      var cursor:ICursor = myArrayCollection.createCursor();
      cursor.seek(CursorBookmark.last);
      while (!cursor.beforeFirst)
      {
          trace(current);
          cursor.movePrevious();
      }
      </pre>
     <p></p>
</div>
<a name="remove()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">remove</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function remove():Object</code><p>
      Removes the current item and returns it.
      If the cursor location is <code>beforeFirst</code> or 
      <code>afterLast</code>, throws a CursorError. 
      If you remove any item other than the last item,
      the cursor moves to the next item. If you remove the last item, the
      cursor is at the AFTER_LAST bookmark.
      
           </p><p>If the item after the removed item is not local and an asynchronous 
      operation must be performed, an ItemPendingError is thrown. 
      See the ItemPendingError documentation and the collections
      documentation  for more information on using the ItemPendingError.</p>
     
      <p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Object</code></td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="errors/ItemPendingError.html" target="">mx.collections.errors.ItemPendingError</a>
</div>
</div>
<a name="seek()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">seek</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function seek(bookmark:<a href="CursorBookmark.html">CursorBookmark</a>, offset:int = 0, prefetch:int = 0):void</code><p>
      Moves the cursor to a location at an offset from the specified
      bookmark.
      The offset can be negative, in which case the cursor is positioned
      an <code>offset</code> number of items prior to the specified bookmark.
           </p><p>If the associated collection is remote, and not all of the items
      have been cached locally, this method begins an asynchronous fetch
      from the remote collection.</p>
           <p>If the data is not local and an asynchronous operation
      must be performed, an ItemPendingError is thrown.
      See the ItemPendingError documentation and the collections
      documentation for more information on using the ItemPendingError.</p>
           <span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">bookmark</span>:<a href="CursorBookmark.html">CursorBookmark</a></code> &mdash; <code>CursorBookmark</code> reference to marker
      information that allows repositioning to a specific location.
      You can set this parameter to value returned from the
      <code>bookmark</code> property, or to one of the following constant 
      bookmark values:
      <ul>
        <li><code>CursorBookmark.FIRST</code> -
        Seek from the start (first element) of the collection</li>
        <li><code>CursorBookmark.CURRENT</code> -
        Seek from the current position in the collection</li>
        <li><code>CursorBookmark.LAST</code> -
        Seek from the end (last element) of the collection</li>
      </ul>
           </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">offset</span>:int</code> (default = <code>0</code>)<code></code> &mdash; Indicates how far from the specified bookmark to seek.
      If the specified number is negative, the cursor attempts to
      move prior to the specified bookmark.
      If the offset specified is beyond the end of the collection,
      the cursor is be positioned off the end, to the 
      <code>beforeFirst</code> or <code>afterLast</code> location.
           </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">prefetch</span>:int</code> (default = <code>0</code>)<code></code> &mdash; Used for remote data. Indicates an intent to iterate 
      in a specific direction once the seek operation completes.
      This reduces the number of required network round trips during a seek.
      If the iteration direction is known at the time of the request,
      the appropriate amount of data can be returned ahead of the request
      to iterate it.
     
      </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="errors/ItemPendingError.html" target="">mx.collections.errors.ItemPendingError</a>
</div>
</div>
<div class="detailSectionHeader">Event detail</div>
<a name="event:cursorUpdate"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">cursorUpdate</td><td class="detailHeaderType">event&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href="../events/FlexEvent.html"><code>mx.events.FlexEvent</code></a>
<br>
<span class="label">FlexEvent.type property = </span><a href="../events/FlexEvent.html#CURSOR_UPDATE"><code>mx.events.FlexEvent.CURSOR_UPDATE</code></a>
<br><p>
  Dispatched whenever the cursor position is updated.
   </p><p>
      The <code>FlexEvent.CURSOR_UPDATE</code> constant defines the value of the
      <code>type</code> property of the event object for a <code>cursorUpdate</code> event.
           </p><p>The properties of the event object have the following values:</p>
      <table class="innertable">
         <tr><th>Property</th><th>Value</th></tr>
         <tr><td><code>bubbles</code></td><td>false</td></tr>
         <tr><td><code>cancelable</code></td><td>false</td></tr>
         <tr><td><code>currentTarget</code></td><td>The Object that defines the
           event listener that handles the event. For example, if you use
           <code>myButton.addEventListener()</code> to register an event listener,
           myButton is the value of the <code>currentTarget</code>. </td></tr>
         <tr><td><code>target</code></td><td>The Object that dispatched the event;
           it is not always the Object listening for the event.
           Use the <code>currentTarget</code> property to always access the
           Object listening for the event.</td></tr>
      </table>
           </div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
